Kona guide #1223
Kona guide #1223
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request introduces documentation updates across multiple files in the Optimism documentation repository. The changes primarily focus on two main aspects: renaming "Further reading" sections to "Next steps" in various documentation files, and adding documentation for the new Kona Fault Proof Virtual Machine (FPVM). A new page for Kona has been created in the fault proofs section, providing detailed information about its implementation, architecture, and role in the OP Stack ecosystem. Additionally, the Sequence DiagramsequenceDiagram
participant User
participant Docs
participant Kona FPVM
participant Asterisc FPVM
User->>Docs: Access Fault Proofs Documentation
Docs->>User: Display Kona FPVM Information
User->>Kona FPVM: Explore Implementation Details
Kona FPVM-->>User: Provide Step-by-Step Execution Info
User->>Asterisc FPVM: Compare Implementations
Asterisc FPVM-->>User: Show Architectural Differences
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used📓 Path-based instructions (1)pages/stack/fault-proofs/kona.mdx (1)Pattern
⏰ Context from checks skipped due to timeout of 90000ms (4)
🔇 Additional comments (15)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
pages/chain/identity/individuals.mdx(1 hunks)pages/chain/identity/projects.mdx(1 hunks)pages/stack/fault-proofs.mdx(1 hunks)pages/stack/fault-proofs/_meta.json(1 hunks)pages/stack/fault-proofs/cannon.mdx(2 hunks)pages/stack/fault-proofs/explainer.mdx(1 hunks)pages/stack/fault-proofs/kona.mdx(1 hunks)pages/stack/fault-proofs/mips.mdx(1 hunks)words.txt(7 hunks)
✅ Files skipped from review due to trivial changes (5)
- pages/stack/fault-proofs/_meta.json
- pages/chain/identity/projects.mdx
- pages/stack/fault-proofs/mips.mdx
- pages/stack/fault-proofs/cannon.mdx
- pages/chain/identity/individuals.mdx
🧰 Additional context used
📓 Path-based instructions (3)
pages/stack/fault-proofs/explainer.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/stack/fault-proofs.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/stack/fault-proofs/kona.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
🪛 LanguageTool
pages/stack/fault-proofs/explainer.mdx
[style] ~108-~108: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...plainer guide on cannon. * Read about the [components of the fault proo...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (1)
words.txt (1)
13-13: LGTM!The new terms are properly capitalized and alphabetically sorted.
Also applies to: 16-16, 155-155, 177-177, 207-207, 305-305, 341-341, 417-417
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
| @@ -8,11 +8,13 @@ import { Card, Cards } from 'nextra/components' | |||
|
|
|||
| # Fault Proofs | |||
|
|
|||
| Documentation covering Cannon, Challenger, Explainer, Fp Components, Fp Security, Mips in the Fault Proofs section of the OP Stack ecosystem. | |||
| Documentation covering Cannon, Kano Challenger, Explainer, Fp Components, Fp Security, Mips in the Fault Proofs section of the OP Stack ecosystem. | |||
There was a problem hiding this comment.
Aside from the typo introduced here, this sentence really needs an overhaul, it doesn't make much sense.
How about: "Documentation covering the Fault Proof system including Cannon, OP-Challenger, Asterisc, and Kona."
|
|
||
| <Cards> | ||
| <Card title="Fault proof VM - Cannon" href="/stack/fault-proofs/cannon" /> | ||
|
|
||
| <Card title="Fault proof VM - Kano" href="/stack/fault-proofs/kona" /> |
There was a problem hiding this comment.
- Typo: "Kano"
- Kona isn't a fault proof VM, it's a fault proof program (equivalent to op-program). Asterisc is the fault proof VM (equivalent to Cannon). So if we have an equivalent to the "Fault proof VM - Cannon" page, it would be ""Fault proof VM - Asterisc"
| @@ -2,6 +2,7 @@ | |||
| "explainer": "Fault proofs explainer", | |||
| "fp-components": "FP system components", | |||
| "cannon": "FPVM: Cannon", | |||
| "kona": "FPVM: Kona", | |||
There was a problem hiding this comment.
As per the comment above, the fault proof VM is Asterisc (not Kona).
| See the [specs](https://specs.optimism.io/experimental/fault-proof/stage-one/bond-incentives.html) for more details. | ||
| ## Next steps | ||
|
|
||
| * For more info about how fault proofs works under the hood, |
There was a problem hiding this comment.
| * For more info about how fault proofs works under the hood, | |
| * For more info about how fault proofs work under the hood, |
| @@ -0,0 +1,106 @@ | |||
| --- | |||
| title: "Fault proof VM - Kona" | |||
There was a problem hiding this comment.
As mentioned above the fault proof VM is Asterisc. So if this page is the equivalent of the Cannon page then it should be "Fault proof VM - Asterisc".
Description
This is an high level guide to Kona, an alternative fault-proof program for the OP Stack.
Tests
Additional context
Metadata